/*
 *  PPXMLReader.h
 *  PPXMLTest
 *
 *  Created by Jacob Basham on 2/1/07.
 *  Copyright 2007, PaperPigeons.net
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions 
 *  are met:
 *  1. Redistributions of source code must retain the above copyright 
 *     notice, this list of conditions and the following disclaimer.
 *	2. Redistributions in binary form must reproduce the above copyright 
 *	   notice, this list of conditions and the following disclaimer in 
 *	   the documentation and/or other materials provided with the distribution.
 *	3. Neither the name of PaperPigeons.net nor the names of its contributors 
 *	   may be used to endorse or promote products derived from this software 
 *	   without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *	"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 *	LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
 *	FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
 *	COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 *	INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 *	BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 *	LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
 *	CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
 *	LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
 *	IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 *	POSSIBILITY OF SUCH DAMAGE.
 */

#import <Foundation/Foundation.h>
#import "libxml/xmlreader.h"


/*!
    @class
    @abstract    (brief description)
    @discussion  (comprehensive description)
*/
@interface PPXMLReader : NSObject 
{
	int _ret;
	SEL _method;
	id _delegate;
	NSString * _path;
	xmlTextReaderPtr _reader;
}

/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
+ (id)readerWithFile:(NSString *)path delegate:(id)delegate;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
+ (id)readerWithXMLData:(NSData *)data delegate:(id)delegate;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
+ (id)readerWithXMLDocument:(NSXMLDocument *)document delegate:(id)delegate;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (id)init;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (NSString *)path;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (void)setPath:(NSString *)path;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (id)delegate;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (void)setDelegate:(id)delegate;

// libxml2 reader function wrappers


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (void)read;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (int)numberAttributes;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (int)depth;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (BOOL)hasAttributes;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (BOOL)hasValue;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (BOOL)isDefault;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (BOOL)isEmptyElement;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (int)nodeType;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (int)quoteChar;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (int)readState;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (BOOL)isNamespaceDecl;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (NSString *)baseURI;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (NSString *)localName;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (NSString *)name;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (NSString *)namespaceURI;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (NSString *)prefix;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (NSString *)XMLLang;

/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (NSString *)characters;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (NSString *)XMLVersion;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (BOOL)isStartElementEqualToString:(NSString *)string;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (NSString *)getAttribute:(NSString *)attribute;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (BOOL)isCharacterData;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (BOOL)isEndElementEqualToString:(NSString *)string;

@end
